package simple.flow.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import org.springframework.http.HttpMethod;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.*;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ParameterType;
import springfox.documentation.service.RequestParameter;
import springfox.documentation.service.Response;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.ArrayList;
import java.util.List;
import java.util.function.Predicate;

@Configuration
@EnableOpenApi
@EnableWebMvc
public class SwaggerConfig {
    @Bean
    Docket docket(Environment environment) {
        // 设置要显示swagger的环境
        Profiles profiles = Profiles.of("dev", "test");
        // 判断当前是否处于该环境
        boolean isOpen = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.OAS_30)
                // 配置网站的基本信息
                .apiInfo(apiInfo())
                // 配置扫描的接口
                .select()
                // 指定接口的位置
                .apis(RequestHandlerSelectors.basePackage("simple.flow"))
                // 过滤请求
                .paths(pathSelectors())
                .build()
                // 设置是否启动Swagger，默认为true（不写即可），关闭后Swagger就不生效了
                .enable(isOpen)
                // 设置全局通用参数
                .globalRequestParameters(getGlobalRequestParameters())
                // 设置通用响应信息
                .globalResponses(HttpMethod.GET, getGlobalResponseMessage())
                .globalResponses(HttpMethod.POST, getGlobalResponseMessage());
    }

    /**
     * 接口基本信息
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 文档标题
                .title("app-boot接口文档")
                // 版本
                .version("1.0")
                // 许可
                .license("Apache 2.0 许可")
                // 拓展
                .extensions(new ArrayList<>())
                .build();
    }

    /**
     * 请求过滤
     *
     * @return
     */
    private Predicate<String> pathSelectors() {
        return PathSelectors.any();
    }

    /**
     * 生成全局通用参数
     *
     * @return
     */
    private List<RequestParameter> getGlobalRequestParameters() {
        List<RequestParameter> requestParameters = new ArrayList<>();
        // 可以添加多个
        requestParameters.add(
                new RequestParameterBuilder()
                        .name("Authorization")
                        .description("存放用户token")
                        .in(ParameterType.HEADER) // 位置
                        .required(false) // 是否必须
                        .hidden(true) // 是否隐藏
                        .build()
        );

        requestParameters.add(
                new RequestParameterBuilder()
                        .name("version")
                        .description("客户端的版本号")
                        .required(false)
                        .in(ParameterType.HEADER)
                        .build()
        );

        return requestParameters;
    }


    /**
     * 生成通用响应信息
     *
     * @return
     */
    private List<Response> getGlobalResponseMessage() {
        List<Response> responseList = new ArrayList<>();
        responseList.add(new ResponseBuilder().code("404").description("找不到资源").build());
        return responseList;
    }
}
